[skip changelog] Document packages[*].platforms[*].deprecated package index field
#1510
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ge index field In the event an Arduino boards platform is deprecated by the maintainer, it will be useful to clearly communicate this fact to the user and ensure they will easily find a preferred alternative platform. In order to facilitate this, a `packages[*].platforms[*].deprecated`field was added to the Arduino package index format and this information is used to enhance the user interfaces of the official Arduino development software. This useful feature is now documented in the Arduino package index specification.
silvanocerza
approved these changes
Oct 14, 2021
d-a-v
pushed a commit
to d-a-v/arduino-cli
that referenced
this pull request
Oct 14, 2021
…ge index field (arduino#1510) In the event an Arduino boards platform is deprecated by the maintainer, it will be useful to clearly communicate this fact to the user and ensure they will easily find a preferred alternative platform. In order to facilitate this, a `packages[*].platforms[*].deprecated`field was added to the Arduino package index format and this information is used to enhance the user interfaces of the official Arduino development software. This useful feature is now documented in the Arduino package index specification.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)Docs update
In the event an Arduino boards platform is deprecated by the maintainer, it will be useful to clearly communicate this
fact to the user and ensure they will easily find a preferred alternative platform. In order to facilitate this, a
packages[*].platforms[*].deprecatedfield was added to the Arduino package index format (#1278) and this information is used toenhance the user interfaces of the official Arduino development software.
This field is undocumented, meaning platform developers will be unlikely be aware of its existence.
This useful feature is now documented in the Arduino package index specification.
titled accordingly?
Not breaking